Saltar al contenido principal

Ficha técnica

Alcances necesarios​

El token para consumir la API de Gestión de lote de pagos debe generarse utilizando el Authorization Code.

El alcance openid es obligatorio. Permite consultar el perfil del usuario BTG con acceso a la cuenta.

Es necesario elegir uno de los siguientes alcances:

AlcanceDescripción
brn:btg:empresas:banking:paymentsPermite crear y consultar pagamentos.

Workflow​

Realización del flujo​

Para la utilización de este recurso, se creó un flujo donde:

  1. El usuario abre un lote antes de realizar las solicitudes de creación de pagos y transferencias:
curl --request POST \
  --url https://api.empresas.btgpactual.com/30306294000145/banking/batch-payments \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: insomnia/9.3.2' \
  --data '{
  "taxId": "30306294000145"
}'

Esta solicitud retorna el identificador del lote batchId:

{
  "batchId": "829c47f2-3b5c-4103-8d15-a55bd66ae905",
  "expiresAt": "2024-11-22T19:18:18.233Z",
  "maxSize": 200,
  "taxId": "46786961000174"
}
  1. Este identificador se utiliza en las solicitudes de creación para señalar que los pagos o transferencias pertenecen a ese lote. El objeto de transferencia o pago dentro del array de items debe tener el batchId acompañado del identificador y agreementId acompañado de "INDIVIDUAL_APPROVE".
{
  items:[
    {
      "type": "PIX_MANUAL",
      "batchId": "829c47f2-3b5c-4103-8d15-a55bd66ae905",
      "agreementId": "INDIVIDUAL_APPROVE",
      "amount": 2,
       //demais informações do pagamento...
      "paymentDate": "2024-12-26"
    },
  ]
}
  1. Luego, el usuario deberá solicitar la finalización y procesamiento del lote, mediante una solicitud PATCH pasando como path parameter su identificador.
curl --request PATCH \
  --url https://api.empresas.btgpactual.com/30306294000145/banking/batch-payments/829c47f2-3b5c-4103-8d15-a55bd66ae905 \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: insomnia/9.3.2' \ \
  --data '{
  "isFinished": true
}'

Si esta solicitud no se realiza y el lote no es abandonado, el procesamiento ocurrirá automáticamente después de la expiración del lote (dato proporcionado junto al identificador cuando el lote es creado).

  1. En caso de que el usuario quiera abandonar un lote, impidiendo que este sea procesado, es posible realizar la siguiente solicitud antes de realizar la solicitud PATCH de procesamiento:
curl --request DELETE \
  --url https://api.empresas.btgpactual.com/30306294000145/banking/batch-payments/829c47f2-3b5c-4103-8d15-a55bd66ae905 \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: insomnia/9.3.2'

De esta forma, abandonando el lote informado en el path parameter.

Particularidades​

Este flujo es particular en el sentido de que altera el comportamiento de la API de pagos de algunas formas.

Validaciones​

En el momento de la solicitud de inserción del pago mediante la solicitud POST realizada, se realizan validaciones sobre los campos ingresados, con el fin de garantizar que todos los campos obligatorios estén presentes.

En el momento de la solicitud de procesamiento del lote PATCH, se validan los datos presentes en el pago, excluyendo del lote los pagos que no están aptos para ser realizados.

Retorno de éxito​

El retorno de la API de pagos, cuando se inserta un pago en un lote, se convierte en 202 - ACCEPTED con body vacío.